<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN">
<html>
<head>
<title>ODA Data Set Element (Eclipse BIRT ROM Documentation)</title>
<link rel="stylesheet" href="../style/style.css" type="text/css"/>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</head>
<body>
<p class="title">Eclipse BIRT Report Object Model (ROM)</p>
<p class="subtitle">OdaDataSet Element</p>
<h1>Element Overview</h1>
<div class="section-text">
An extended data set retrieved by a query through an ODA driver that
implements the Open Data Access (ODA) interfaces.</div>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Display Name:</td>
<td>ODA Data Set</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>XML Element:</td>
<td><code>oda-data-set</code></td></tr>
<tr><td>Extends:</td>
<td><a href="SimpleDataSet.html">SimpleDataSet</a></td></tr>
<tr><td>Extendable:</td>
<td>Yes</td></tr>
<tr><td>Abstract:</td>
<td>No</td></tr>
<tr><td>Name Space:</td>
<td>Data Sets</td></tr>
<tr><td>Name Requirement:</td>
<td>Required</td></tr>
<tr><td>Allows User Properties:</td>
<td>Yes</td></tr>
<tr><td>Has Style:</td>
<td>No</td></tr>
</table>

<h3>Property Summary</h3>

<dl class="section-text">
<dt><a href="#Property-dataSource">dataSource</a></dt>
<dd>The database connection that the data set is used.</dd>
<dt><a href="#Property-designerState">designerState</a></dt>
<dd></dd>
<dt><a href="#Property-designerValues">designerValues</a></dt>
<dd></dd>
<dt><a href="#Property-extensionID">extensionID</a></dt>
<dd>The ID of a data set type supported by the ODA data source extension.</dd>
<dt><a href="#Property-privateDriverProperties">privateDriverProperties</a></dt>
<dd>A dynamic list of name-value structures that specify private data or
attributes specific to the ODA data set query.</dd>
<dt><a href="#Property-queryText">queryText</a></dt>
<dd>The static query text to execute.</dd>
<dt><a href="#Property-resultSet">resultSet</a></dt>
<dd>Defines the columns of the expected result set.</dd>
<dt><a href="#Property-resultSetName">resultSetName</a></dt>
<dd>Identifies which result set to access if a query returns multiple result
sets.</dd>
<dt><a href="#Property-resultSetNumber">resultSetNumber</a></dt>
<dd></dd>
</dl>

<h3>Inherited Properties</h3>

<p class="section-text">
<a href="DataSet.html#Property-cachedMetaData">cachedMetaData</a>, 
<a href="DataSet.html#Property-columnHints">columnHints</a>, 
<a href="ReportElement.html#Property-comments">comments</a>, 
<a href="DataSet.html#Property-computedColumns">computedColumns</a>, 
<a href="DesignElement.html#Property-customXml">customXml</a>, 
<a href="SimpleDataSet.html#Property-dataSetRowLimit">dataSetRowLimit</a>, 
<a href="ReportElement.html#Property-displayName">displayName</a>, 
<a href="ReportElement.html#Property-displayNameID">displayNameID</a>, 
<a href="ReportElement.html#Property-eventHandlerClass">eventHandlerClass</a>, 
<a href="ReportElement.html#Property-extends">extends</a>, 
<a href="DataSet.html#Property-filter">filter</a>, 
<a href="ReportElement.html#Property-name">name</a>, 
<a href="DataSet.html#Property-needsCache">needsCache</a>, 
<a href="ReportElement.html#Property-newHandlerOnEachEvent">newHandlerOnEachEvent</a>, 
<a href="SimpleDataSet.html#Property-paramBindings">paramBindings</a>, 
<a href="DesignElement.html#Property-propertyMasks">propertyMasks</a>, 
<a href="SimpleDataSet.html#Property-refTemplateParameter">refTemplateParameter</a>, 
<a href="DataSet.html#Property-rowFetchLimit">rowFetchLimit</a>, 
<a href="DataSet.html#Property-sortHints">sortHints</a>, 
<a href="DesignElement.html#Property-userProperties">userProperties</a>, 
<a href="ReportElement.html#Property-viewAction">viewAction</a>
</p>
<h3>Inherited Methods</h3>

<p class="section-text">
<a href="SimpleDataSet.html#Method-beforeOpen">beforeOpen</a>, 
<a href="SimpleDataSet.html#Method-beforeClose">beforeClose</a>, 
<a href="SimpleDataSet.html#Method-onFetch">onFetch</a>, 
<a href="SimpleDataSet.html#Method-afterOpen">afterOpen</a>, 
<a href="SimpleDataSet.html#Method-afterClose">afterClose</a></p>
<h3>Description</h3>

<div class="section-text">
<p>The ODA Data Set represents an extended data set that implements the Open
Data Access (ODA) interfaces. The ODA interface defines a rich set of meta-data
attributes available to the BIRT Designer to help the user build the report.
The ODA Data Set definition contains the minimum amount of information
necessary to access the desired data source. The rest of the available
meta-data information is obtained from the ODA driver when needed.</p>

<p>The ODA Data Set element defines a single ODA data set of a specific type.
An ODA Data Source may support one or more types of ODA data sets.</p>

<p>Both the data set element and the ODA driver can provide column definition
and hints. Data-access attributes, such as name and type, are typical derived
attributes. They are defined in the inherited <code>resultSet</code> definition, and are
used only if the run-time driver cannot provide such meta-data. </p>

<p>An ODA driver may statically define driver-specific data set query
properties by defining the <code>property</code> element in the ODA data
source extension point (<i>org.eclipse.birt.data.oda.dataSource</i>).  
See the BIRT Extensions functional
specification document for more detail description. By implementing the
extension point, an ODA driver's extension plug-in manifest (plugin.xml) could define
static driver-specific data set query properties. BIRT uniquely identifies each
extension-defined property within the scope of its ODA extension.  BIRT supports 
these properties as extended
ROM properties with all their built-in features, such as direct editing from
the BIRT designer's property sheet. For ease of segregating these
driver-specific properties in the property sheet, one could define them within
a <code>propertyGroup</code>
element with a group display name like &quot;Query Properties&quot;.  Such grouping is purely for display in a
property sheet.  Each property in a
display group is treated as a top-level property, whose grouping is not visible,
when it is accessed programmatically.  At Factory time, these static extension-defined properties are passed in
name-value pairs to the ODA driver as a query's run-time properties.</p>

<p>See the Description of the ODA Data Source element for an example of the ODA
data source extension plug-in manifest.</p></div>
<h3>See Also</h3>

<div class="section-text">
<p><code>OdaDataSource element</code></p>
<p><code>DataSet element</code></p>
<p><code>DataSet</code> scripting object</p></div>
<h1>Property Detail</h1>

<h2><a name="Property-dataSource">dataSource Property</a></h2>

<p class="section-text">The database connection that the data set is used.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../elements/DataSource.html">DataSource</a> Reference</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>Yes</td></tr>
<tr><td>Display Name:</td>
<td>Data source</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>Name of the data source, that is the database connection this data set is using.</p></div>

<hr>
<h2><a name="Property-designerState">designerState Property</a></h2>

<p class="section-text"></p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../structs/OdaDesignerState.html">OdaDesignerState</a> Structure</td></tr>
<tr><td>Since:</td>
<td>2.1</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Designer state</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Hidden</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>


<hr>
<h2><a name="Property-designerValues">designerValues Property</a></h2>

<p class="section-text"></p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#xml">xml</a></td></tr>
<tr><td>Since:</td>
<td>2.1.1</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Designer values</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>


<hr>
<h2><a name="Property-extensionID">extensionID Property</a></h2>

<p class="section-text">The ID of a data set type supported by the ODA data source extension.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#string">string</a></td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Extension ID</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Hidden</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>The fully qualified ID that uniquely identifies the type
of ODA data set definition in the BIRT environment.  It is defined in the ODA data
source extension plug-in manifest (plugin.xml) in the <code>dataSet.id</code>
attribute. Its value is optional
if the ODA extension supports only one type of data set.</p></div>

<hr>
<h2><a name="Property-privateDriverProperties">privateDriverProperties Property</a></h2>

<p class="section-text">A dynamic list of name-value structures that specify private data or
attributes specific to the ODA data set query.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td>List of <a href="../structs/ExtendedProperty.html">ExtendedProperty</a> Structures</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Private driver properties</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Hidden</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>A dynamic list of name-value structures (<code>ExtendedProperty</code> structures) that
specify private run-time data or attributes specific to the ODA data set. This
is an optional element that an ODA driver may use to store and pass pertinent
driver-specific attributes from its designer tool to the run-time driver. The
content of this element is specific and private to an ODA driver, whose
designer tool can dynamically define and update them as appropriate. These
name-value pairs are stored in the report design file as a persistent service,
and are passed to the ODA driver at Factory time as a query's run-time
properties.</p></div>
<h3>See Also</h3>

<div class="section-text">
<p><code>DataSetParam structure</code></p>
<p><code>ParamBinding structure</code></p></div>

<hr>
<h2><a name="Property-queryText">queryText Property</a></h2>

<p class="section-text">The static query text to execute.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#xml">xml</a></td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Query</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>The query text used in opening a data set. Specific ODA driver defines the
format of this string. The query text is passed through to the ODA run-time
driver to prepare a query for execution.</p></div>

<hr>
<h2><a name="Property-resultSet">resultSet Property</a></h2>

<p class="section-text">Defines the columns of the expected result set.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td>List of <a href="../structs/OdaResultSetColumn.html">OdaResultSetColumn</a> Structures</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Result set columns</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Hidden</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>Defines the data access attributes of&nbsp;the list of columns in the expected primary result set. This is an optional list of result set column definitions, used only when the underlying data provider cannot provide this information.&nbsp;When contradicting meta-data are found between those provided dynamically by a data provider and&nbsp;those specified in a data set definition, the data provider&iuml;&iquest;&frac12;s meta-data takes precedence.</p></div>
<h3>See Also</h3>

<div class="section-text">
<p><code>ResultSetColumn structure</code></p></div>

<hr>
<h2><a name="Property-resultSetName">resultSetName Property</a></h2>

<p class="section-text">Identifies which result set to access if a query returns multiple result
sets.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#string">string</a></td></tr>
<tr><td>Since:</td>
<td>reserved</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Result set name</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Hidden</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>Some ODA drivers provide multiple named result sets from a single query. In
the first release, BIRT can access only one of these result sets. This property
identifies which named result set to access. The inherited <code>resultSet</code>
definition, if specified, is for this result set. </p>

<p>Required if multiple result sets are available, and a result set must be accessed
by name. This property is not applicable when multiple result sets are returned
in sequence; the first result set is treated as the primary result set.</p></div>

<hr>
<h2><a name="Property-resultSetNumber">resultSetNumber Property</a></h2>

<p class="section-text"></p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#integer">integer</a></td></tr>
<tr><td>Since:</td>
<td>2.3</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Result set number</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>1</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

</body>
</html>
